/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package bd.org.apache.commons.math.exception.util;

import java.io.Serializable;
import java.util.Locale;

/**
 * Interface for localizable strings.
 *
 * @version $Id: Localizable.java 1244107 2012-02-14 16:17:55Z erans $
 * @since 2.2
 */
public interface Localizable extends Serializable {

    /**
     * Gets the source (non-localized) string.
     *
     * @return the source string.
     */
    String getSourceString();


    /**
     * Gets the localized string.
     *
     * @param locale locale into which to get the string.
     * @return the localized string or the source string if no
     *         localized version is available.
     */
    String getLocalizedString(Locale locale);
}
